Added feature: UUID obfuscation in URI label with URI_METRICS_DETAILED enabled #123
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
thanks @comemaryvallee, that seems very useful. It reduces cardinality but also avoids leaking UUIDs. Is this something you're also interested in @CathalOConnorRH ? |
Hey @pb82 This might be something we could use alright, let me know if you would like me to test this change. |
|
@CathalOConnorRH I'm interested in this changes too, any chances that this PR get merged to the master? And when is the next release expected? |
|
Yes, makes sense. We can include it in a patch release. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Monitor metrics per realms without constraint of high cardinality due to the presence of UUIDs in the URI label.
What
Added the option to replace user's or client's UUID value in the URI label to a generic
{id}value even when the URI_METRICS_DETAILED system variable is set totrue.Why
Needed to be able to monitor metrics with the realm name value present in the URI label but without UUIDs values, due to its high cardinality. The keycloak-metrics-spi evolution added the obfuscation of UUIDs only with the obfuscation of realm name value.
How
By adding a check for a URI_METRICS_UUID_HIDED system variable set to
true& by adding "users" value to the condition of UUID obfuscation.Checklist:
Additional Notes
Modified the README.md to add the description of this feature.